Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the switch to implementing own stubs easier #255

Merged
merged 8 commits into from
Jan 8, 2018
Merged

Make the switch to implementing own stubs easier #255

merged 8 commits into from
Jan 8, 2018

Conversation

wolf99
Copy link
Contributor

@wolf99 wolf99 commented Jan 5, 2018

This PR is opened with regard to #252 where it was decided to add headers for the core exercise isogram and the non-core exercises that it unlocks, and also to add hints.md files for the following core exercise gigasecond and the non-core exercises that it unlocks to explain how a student should add their own headers.

I have so far added the stub headers to isogram, acronym and pangram.
I have also added a first draft of a hints.md file to gigasecond

The hints.md file also needs to be added to space-age and meetup. I delay in adding them to make any edits that anyone suggests to the gigasecond one before copying it over.

Also, I am not sure how to correctly regenerate the README.md. I have downloaded the configlet and unzipped it, then cloned the problem-specifications repository to the same directory (which also holds the c repository). Then in the root of the c repository I run

../configlet generate . --only gigasecond --spec-path ../problem-specifications

(all as outlined here: exercism/java#1085)
But nothing seems to happen and the README.md remains unchanged... What have I done wrong?

@wolf99
Copy link
Contributor Author

wolf99 commented Jan 5, 2018

Figured out the configlet thing by reading https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md. The hints.md needs to be in a .meta sub-directory within the exercise directory.

Would like feedback on the hints.md itself still though 😃

@ryanplusplus
Copy link
Member

I made a quick commit that addresses a few typos and fixes up a bit of formatting. Please have a look and make sure I didn't screw anything up. Otherwise this looks good to me.


Before you are finished with the header file, you should add include guards.
Include guards are used to help prevent the file from being included multiple times by accident.
If the file _was_ included multiple times then the functions and other items would be declared twice; In C this is an error because the compiler thinks you are trying to declare another _different_ function that has the same name.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ; could probably just be a ., but I tried to take only a half step away from the em dash.

@wolf99
Copy link
Contributor Author

wolf99 commented Jan 7, 2018

Thanks @ryanplusplus I've now added hints to the other two relevant exercises and regenerated the README.md files. So this PR should be good to go.

For gigasecond, meetup and space-age
@wolf99 wolf99 changed the title WIP: Make the switch to implementing own stubs easier Make the switch to implementing own stubs easier Jan 7, 2018
@ryanplusplus
Copy link
Member

LGTM

@wolf99 wolf99 merged commit c0f791d into exercism:master Jan 8, 2018
@wolf99 wolf99 deleted the smoothen-path-to-implementing-headers branch January 8, 2018 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants